home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Franz PD / Franz PD Disk #173 (1992)(Rhein-Sieg-Soft).zip / Franz PD Disk #173 (1992)(Rhein-Sieg-Soft).adf / TOM / TOM_ENG.doc < prev    next >
Text File  |  1992-03-23  |  12KB  |  297 lines
  1. ==============================================================================
  2. ==============================================================================
  3.  
  4.     English Documentation
  5.  
  6. ==============================================================================
  7. ==============================================================================
  8.  
  9. ==============================================================================
  10. ==============================================================================
  11. ===                         TOM V2.00a rel. 1203-92                        ===
  12. ==============================================================================
  13. ===                          ( S H A R E W A R E )                         ===
  14. ==============================================================================
  15. ===              (needs V35.15 or higher of "ak_gen0.library")             ===
  16. ==============================================================================
  17. ===                                                                        ===
  18. ===                       (c) 1990-92 by Andreas Ralph Kleinert            ===
  19. ===                                      Grube Hohe Grethe 23              ===
  20. ===                                      W-5900 Siegen 1                   ===
  21. ===                                      Germany                           ===
  22. ===                                                                        ===
  23. ==============================================================================
  24. ==============================================================================
  25.  
  26.      "TOM" is (C)opyright 1990-92 by Andreas R. Kleinert
  27.      and may be freely distributed. A payment of the SHARE-fee is
  28.      welcomed, but not "forced". A possibly amount as a copy-fee per disk
  29.      should not be higher than $7.5 (10 DM) or five as much as the price
  30.      for the empty disk (all restrictions made in older versions of TOM
  31.      does are no longer valid !). SUPPORTED by me is a fee which is just
  32.      as high as the costs of the distributor are.
  33.      TOM may not be distributed divided into parts (only complete) !!!
  34.      Parts of TOM are : 
  35.  
  36.       - this Doc-File
  37.       - the other content of this directory, if marked as a part of TOM.
  38.  
  39.              ----- Docfile-Version : V2.00a-A-1203-92 -----
  40.  
  41. =============================================================================
  42. = DESCRIPTION :                                                             =
  43. =============================================================================
  44.  
  45.     TOM is a Mini-Translation-Program for a quick single-word translation
  46.     from English to German and reverse.
  47.     The vocabulary is easy to complete.
  48.     TOM is also able to be started from the CLI (Shell) as well as from the
  49.     Workbench (then via a special integrated, comfortable Intuition-inter-
  50.     face).
  51.     The Intuition-interface is also accessable from the CLI, when starting
  52.     TOM without any parameters.
  53.  
  54.     TOM is a shortcut for "Translate-O-Mat".
  55.  
  56. =============================================================================
  57. = ATTENTION :                                                               =
  58. =============================================================================
  59.  
  60.      THIS PROGRAM IS SHAREWARE !!!
  61.  
  62.    - What does that mean in this case ?
  63.  
  64.      If you often use this program, please pay the SHARE-fee of $7.5 (DM 15)
  65.      to my address. But this is fully voluntarily (this is the reason why
  66.      this program has not to be called "commercial") !!!
  67.      When you have paid the fee, you may at a time get the the latest version
  68.      from me by sending me enough money for postage/packing and an empty disk.
  69.      Please wait at least two or three months before asking for the next ver-
  70.      sion update.
  71.  
  72.      This offer is then obsolete and ends, when I'm no longer able (no
  73.      matter what reason) to manage the many requests for this program to the
  74.      conditions desribed above.
  75.  
  76.    - What will happen, if this offer does no longer stand sometime in the
  77.      future ?
  78.  
  79.      Alternatives then :
  80.  
  81.      a) No more enhancements to the program will be made.
  82.         (Possible, but not realistic.)
  83.  
  84.       or :
  85.  
  86.      b) This program could be distributed as a kind of COMMERCIAL Shareware,
  87.         maybe with better conditions for the people, who already paid the
  88.         voluntary Share-fee.
  89.  
  90.       or :
  91.  
  92.      c) This program could be selled as a completely commercial product.
  93.  
  94.      Summary :
  95.  
  96.      If somebody sent me - AFTER becoming this offer obsolete - $7.5 + disk
  97.      + PP, then I'll send all that back, by using the necessary part of the
  98.      PP (disk empty), and I'll add an information containing all might be
  99.      interested in about the new version of the program (status a,b,c,?).
  100.      I also would send the PP and the disk back to the people who already
  101.      paid the SHARE-fee sometime before, but maybe for this people together
  102.      with a special offer (as described under b) ) for the new version of the
  103.      program.
  104.  
  105.      But this is currently all not in a realistic view. I also don't think
  106.      that this program now is good enough to have a realistic chance as
  107.      a commercial (Share-)Ware.
  108.  
  109.      So think about sponsoring the (voluntarily) Shareware-idea, without
  110.      any risks ($7.5 is not much) and get the possibilitie to get quick and
  111.      easy updates, directly from the programmer (without any bad changes made
  112.      to the original) !
  113.  
  114.    - Necessary information I have to get :
  115.  
  116.      - Current version of the program you own, so that I see, if an update
  117.        is already (still) possible or makes sense.
  118.      - Your telefon number, full address and BBS.
  119.  
  120. =============================================================================
  121. = INSTALLATION :                                                            =
  122. =============================================================================
  123.  
  124.    Copy the latest version of the "ak_gen0.library" into your LIBS:-direc-
  125.    tory !
  126.  
  127.    For a correct working with TOM you have to make some installations be-
  128.    fore using it :
  129.  
  130.    At first create a logical device named "DATA:", where TOM may search
  131.    for his "vocabulary". This can happen with the ASSIGN-command from the
  132.    Workbench (or anywhere else, never mind).
  133.    The directory, on which "DATA:" has to point, lies on this disk and
  134.    contains the data TOM uses (Files "a" to "z").
  135.    Perhaps you will copy this files to your RAM-Disk for an increasement
  136.    of speed.
  137.    
  138.    Exmaple :
  139.     
  140.           ASSIGN DATA: DF0:TOM/DATA
  141.           ASSIGN DATA: RAM:DATA
  142.           ASSIGN DATA: RAM: 
  143.  
  144. =============================================================================
  145. = HOW TO USE :                                                              =
  146. =============================================================================
  147.  
  148.    (1) Use from Workbench :
  149.  
  150.        (No explanation necessary, I think.
  151.  
  152.    (2) Use from the CLI/Shell :
  153.  
  154.        The way of translating a word :
  155.  
  156.     --- from English to German :
  157.  
  158.         TOM <englisch word> -g
  159.  
  160.     --- von Deutsch nach Englisch :
  161.  
  162.         TOM <deutsches Wort> -e
  163.  
  164.    (For some examples look some lines downward.)
  165.  
  166.    Substantives, which are similar to adjectives or adverbs are defined
  167.    as "the_<word>" instead of "<word>", which is then the adjective/adverb.
  168.  
  169.    If a word is not stored in the archiv, TOM prints out an error message,
  170.    telling this to you. The same happens, if you forgot to assign the
  171.    logical device "DATA:", or if you used it as an alias for the wrong di-
  172.    rectory.
  173.  
  174.    Translating an german word into english needs a little bit more time than
  175.    doing it reverse, because of the structure of the data-files (e -> g).
  176.    If you're using TOM from the CLI, you may control the searching process
  177.    by watching the messages, which are given out by TOM (when translating
  178.    to german). They tell you, which data-file is currently scanned.
  179.  
  180.    Here are some exmaples for correct use :
  181.  
  182.       At first :  assign DATA: <???>
  183.  
  184.       Exp. (1) [G -> E] :
  185.         
  186.          Input  : "TOM airplane -g"
  187.  
  188.          Output : "--- airplane == flugzeug ---"
  189.  
  190.       Exp. (2) [E -> G] :
  191.  
  192.          Input  : "TOM flugzeug -e"      
  193.  
  194.          Output : "--- flugzeug == airplane ---"
  195.  
  196.       TIP :
  197.  
  198.             The string-gadgets may be erased by using the key combination
  199.             <CTRL-X>.
  200.  
  201. =============================================================================
  202. = VERSION-"HISTORY" :                                                       =
  203. =============================================================================
  204.  
  205.    V1.0 :
  206.  
  207.     - just a work-version, which does no longer exist
  208.  
  209. ------------------------------------------------------------------------------
  210.  
  211.    V1.1 :
  212.  
  213.     - first "real" version of TOM
  214.  
  215. ------------------------------------------------------------------------------
  216.  
  217.    V1.2 a/b :
  218.  
  219.     - optimized, shortened Code
  220.     - correction of some bugs
  221.     - better error-handling
  222.  
  223. ------------------------------------------------------------------------------
  224.  
  225.    V1.3 :
  226.  
  227.     - slightly changed "outfit"
  228.     - optimized code
  229.  
  230. ------------------------------------------------------------------------------
  231.  
  232.    V1.5a :
  233.  
  234.     - now with an Intuition-interface (activation via CLI-start without pa-
  235.       rameters or Workbench-start)
  236.     - some optimizations -> relatively shortened code
  237.     - other things
  238.  
  239. ------------------------------------------------------------------------------
  240.  
  241.    V1.5b :
  242.  
  243.     - use of "ak_gen0.library" V34.01
  244.     - some "cosmetic" corrections
  245.  
  246. ------------------------------------------------------------------------------
  247.  
  248.    V2.00a :
  249.  
  250.     - use of "ak_gen0.library" V35.15
  251.     - Internal enhancements
  252.     - Case-Sensitivity desactivated
  253.     - Fixed a bug in the Load-Routine
  254.     - now with the new 3 D-look of the Workbench V2.04
  255.     - Use of PRAGMAs
  256.     - Bug in the memory delocation (order) fixed
  257.     - new "Clear"-Gadget for erasing the String-Gadgets
  258.  
  259. ------------------------------------------------------------------------------
  260. ------------------------------------------------------------------------------
  261.  
  262.    Known bugs :
  263.  
  264.    - There are no (known) bugs.
  265.      (For knwon bugs of the "ak_gen0.library", look into its Docfile !)
  266.  
  267. ------------------------------------------------------------------------------
  268. ------------------------------------------------------------------------------
  269.  
  270.    Possible enhancements in future versions :
  271.  
  272.   - optimized search for the words, which means e.g. one "DATA:" for German,
  273.     one for English or so
  274.   - bug-fixing
  275.     (send me BUG-reports !!!)
  276.  
  277. =============================================================================
  278. = INFORMATIONS ABOUT THE 'ak_gen0.library' :                                          =
  279. =============================================================================
  280.  
  281.     The "ak_gen0.library" has it's own documentation.
  282.     Please read it carefully !
  283.     Thanks.
  284.  
  285. =============================================================================
  286. = COPYRIGHTS :                                                              =
  287. =============================================================================
  288.  
  289. =============================================================================
  290. =   "ak_gen0.library"                                                       =
  291. =   (c) 1989-92 by Andreas R. Kleinert.                                     =
  292. =   FREEWARE. All rights reserved.                                          =
  293. =============================================================================
  294. =   Copyrights of other mentioned products/programs are listed find in the  =
  295. =   manuals of these and are not listed explicitely at this place here.     =
  296. =============================================================================
  297.